﻿using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace Chisholm.Windows.Live.Security
{
    /// <summary>
    /// This interface governs the available security providers used to obtain Windows Live 
    /// credentials
    /// </summary>
    public interface ISecurityProvider
    {
        /// <summary>
        /// This searches the given security provider, and returns the Windows Live ID for the 
        /// given identity credentials passed through
        /// </summary>
        /// <param name="credentials">An object containing the particular identity credentials</param>
        /// <param name="configuration">A configuration string (if required) for the provider</param>
        /// <param name="windowslivedomain">The Windows Live e-mail domain (e.g. my.uni.edu.au)</param>
        /// <returns>The Windows Live ID for the given credentials</returns>
        string GetWindowsLiveID(object credentials, string configuration, string windowslivedomain); 
    }
}
